iAyuda | Ayuda y Soporte

Cuando nos encontramos con programas grandes, en las cuales involucran varias funciones dentro del mismo, es conveniente tener ayuda y atajos de estas funciones definidas para identificar qué hace, qué parámetros lleva, y qué devuelve como resultado. Aplicando el PHPDocs, será posible poder encontrar la función como si fuera una función nativa de PHP:

Primero, declarar la definición de ayuda, parámetros y retorno a partir de la siguiente estructura de código justo encima de su definición:

    /**
     * Función para hacer algo en el programa
     * @param int numero
     * @param String cadena1
     * @return bool true si resultó OK.
     */
    function miFuncion($numero,$cadena1){ return true;}

Luego, asegurarse de tener las extensiones de PHP, como por ejemplo IntelliPhense, o Intellisense.

Utilizar la función. Ahora estamos en el momento de identificar nuestra función y saber para que servía y qué parámetros tengo que pasarle.

Ejemplo.

Tenemos la siguiente función y queremos invocarla:

    /**
     * Función para cargar archivos adjuntos de manera estandar en un registro de WF. De manera inicial, el archivo debe estar alojado en la carpeta estandar (files/files_registracion)
     * @param int $id_form Numero de formulario el cual se adjuntará el archivo.
     * @param String $file_upload Nombre del archivo (Incluído su extensión).
     * @param int $id_ot ID de Registro que asociará el archivo. 
     * @param int $id_connect [OPCIONAL] uid del usuario que carga el archivo Por defecto es 1.
     * @param int $parte [OPCIONAL] numero de parte el cual quiere adjuntar. Por defecto es 1.
     * @return bool true si pudo cargar el archivo correctamente
     */

  function uploadFile($id_form,$file_upload,$id_ot,$id_connect = 1 ,$parte = 1)

Como vemos, ya nos figura nuestra función con su lista de parámetros.

Si la seleccionamos con el ENTER, VSCode nos comenzará a describir que parámetro espera recibir la función, según la posición del cursor:

Si posicionamos el cursor sobre la función, nos explicará el objetivo de la misma y el detalle de cada parámetro con su correspondiente retorno. Dentro del ayuda es posible scrollear:

¿Le ha sido útil esta información?